home *** CD-ROM | disk | FTP | other *** search
/ Graphics Bonanza / Graphics Bonanza.iso / prog2 / wgt35 / wgtlib.doc < prev    next >
Encoding:
Text File  |  1993-01-28  |  4.8 KB  |  136 lines
  1.                  WGT Data File Manager
  2.                   Version 1.0
  3.              Copyright 1992 Barry Egerter
  4.  
  5.  
  6.  
  7.  
  8.     What Is This System For ?
  9.     -------------------------
  10.     
  11.     The library system was designed to allow programmers to combine
  12.     all of their data files into one large password-protected file.
  13.     This file is then accessed by your programs using a unit included
  14.     with the package. It can drastically reduce the number of files
  15.     sitting around in a directory, and reduces the chances that one
  16.     of the necessary files is stored in an improper directory.
  17.  
  18.     Our original use of this system was for the WGT programming kits
  19.     for designing 320*200*256 graphics programs. Our system saves
  20.     palette files, bit-blocks, compressed images, sprite files,
  21.     maps for games, etc. This built up into a huge number of data
  22.     files when we designed a game or utility. To relieve the pressure
  23.     of finding the files, WGTLIB.EXE was created.
  24.  
  25.  
  26.  
  27.  
  28.     WGTLIB.EXE
  29.     ----------
  30.  
  31.     WGTLIB.EXE is the basis of the entire system. It is a DOS parameter
  32.     based program which combines the given files into a LIBRARY. You
  33.     begin by specifying a library filename, password (if desired), and
  34.     then specify individual filenames. To understand how it works, I
  35.     will show several examples of legal commands.
  36.  
  37.     Options:
  38.         +          Add file to library
  39.         -          Remove file from library
  40.         *          Extract file without removing it
  41.         -* or *-   Extract file and remove it from library
  42.         +$       Add password to library
  43.         -$       Remove password from library
  44.         *$       Modify existing password
  45.         @       Execute commands in listfile
  46.  
  47.     Examples:
  48.     ---------
  49.     
  50.     To update a library file called TEST.LIB and add LIBFILE.DOC,
  51. TYPE    WGTLIB TEST.LIB +LIBFILE.DOC (enter)
  52.  
  53.     To update TEST.LIB and add two files and a password,
  54. TYPE    WGTLIB TEST.LIB +WGTLIB.EXE +$MYPASSWORD +LIBFILE.TPU
  55.  
  56.     To view the contents of TEST.LIB (with password),
  57. TYPE    WGTLIB TEST.LIB #MYPASSWORD
  58.  
  59.     To remove WGTLIB.EXE from TEST.LIB,
  60. TYPE    WGTLIB TEST.LIB #MYPASSWORD -WGTLIB.EXE
  61.  
  62.     To remove the password from TEST.LIB,
  63. TYPE    WGTLIB TEST.LIB #MYPASSWORD -$
  64.  
  65.     To execute all commands within a listfile,
  66. TYPE    WGTLIB TEST.LIB @MAKEFILE.DAT
  67.     Where MAKEFILE.DAT contains +,-,*,-* or *-,+$,-$,*$ commands
  68.     (one per line)
  69.  
  70.  
  71.     NOTES:
  72.         -any time you specify a library filename which does not
  73.          exist, WGTLIB creates a new file
  74.         -once a password is added, you must specify what it is
  75.          using # and the password as the second parameter for
  76.          all subsequent commands
  77.         -removing a password only requires a -$, no other parameters
  78.         -full pathnames are accepted anywhere a filename is used
  79.         -passwords are a maximum of 15 characters
  80.  
  81.  
  82.  
  83.     Commands which use the library files created with this program
  84. are contained within the documentation of WGT version 3.0. 
  85. Using a library file is very simple:
  86.  
  87. Initialize the library file by calling
  88.     setlib("libfile.wlb");
  89. If you set a password on the file, call
  90.     setpassword("secret");
  91. All other commands in WGT which load something off the disk will look
  92. in the library file. To test it, make a new directory and copy your
  93. program and the library file. Do not copy the separate files you put
  94. inside the library file. Try running the program. It should work with
  95. no problems unless you forgot to put a file in the library, or you
  96. have pathnames in your load commands.
  97. Note: FLI files cannot be run from a WGT library file.
  98.  
  99.  
  100.  
  101.     Suggestions for files to store in a library:
  102.     --------------------------------------------
  103.  
  104.     1) Anything which you would like to remain hidden from the user.
  105.     2) Graphics images to be used in a program.
  106.     3) Sound files (VOC,CMF,MOD)
  107.     4) EXE'S and COM's that you rarely use (ZIP the library and store
  108.        on a floppy). This prevents separation of related files when
  109.        backing up information.
  110.     5) Drivers, etc. which a program requires to run. A neat trick is
  111.        to store multiple drivers within the library. If you use different
  112.        video, sound, or printer drivers according to the user's setup,
  113.        you can store all the posibilities in one file. Then when the
  114.        program runs, it loads the appropriate driver into a buffer and
  115.        outputs it to disk. Now the user has only the necessary files in
  116.        the directory. (can be done in memory instead of disk obviously)
  117.     6) Programmers can store all files to deal with a particular
  118.        project in one file. I use it to store my source code for each
  119.        version of a shareware release that I create.
  120.     7) Anything else that I haven't thought of.
  121.  
  122.  
  123.  
  124.  
  125.  
  126.     Comments should be forwarded to:
  127.  
  128.     Barry Egerter        Barry Egerter
  129.     94 Andover Drive    SOFTNET BBS
  130.     London, Ontario        (519) 457-0065
  131.     N6J 3X2            Conference #10 (Homegrown)
  132.  
  133.     Anyone who calls the above BBS may download any of my shareware
  134.     products as free downloads on their first call. Validation is not
  135.     required for long distance callers.
  136.